/*
 *  PPURLConnection.h
 *  PigeonsFoundation
 *
 *  Created by Jacob Basham on 1/16/07.
 *  Copyright 2007, PaperPigeons.net
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *  1. Redistributions of source code must retain the above copyright 
 *     notice, this list of conditions and the following disclaimer.
 *	2. Redistributions in binary form must reproduce the above copyright 
 *	   notice, this list of conditions and the following disclaimer in 
 *	   the documentation and/or other materials provided with the distribution.
 *	3. Neither the name of PaperPigeons.net nor the names of its contributors 
 *	   may be used to endorse or promote products derived from this software 
 *	   without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 *	FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 *	COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 *	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 *	BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 *	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 *	LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
 *	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *	POSSIBILITY OF SUCH DAMAGE.
 */

#import <Foundation/Foundation.h>


/*!
    @class
    @abstract    (brief description)
    @discussion  (comprehensive description)
*/
@interface PPURLConnection : NSObject 
{
	BOOL _run;
	NSError * _error;
	id _authenticator;
	NSRunLoop * _runLoop;
	NSMutableData * _data;
	NSURLRequest * _request;
	NSHTTPURLResponse * _response;
}

/*!
    @method     
    @abstract   Send a synchronous request.
    @discussion Returns NSData of response, response and error.
	@param request URL request to send
	@param authenticator Delegate to attach authentication data.
	@param **response return response object
	@param **error return error object
*/
+ (NSData *)sendSynchronousRequest:(NSURLRequest *)request
	authenticator:(id)authenticator 
	returningResponse:(NSHTTPURLResponse **)response
	error:(NSError **)error;

/*!
    @method     
    @abstract   Initializes object.
    @discussion Authenticator object should respond to 
				authenticateRequest:(NSURLRequest **)request
	@param authenticator Authentication delegate.
*/
- (id)initWithAuthenticator:(id)authenticator;


/*!
    @method     
    @abstract   Starts the request.
    @discussion (comprehensive description)
*/
- (void)loadURLRequest:(NSURLRequest *)request;

/*!
    @method     
    @abstract   Returns the requests data.
    @result 	Data returned from request.
*/
- (NSData *)data;

/*!
    @method     
    @abstract   Returns the requests error.
    @result		Error returned from request.
*/
- (NSError *)error;

/*!
    @method     
    @abstract   Returns the requests response.
    @result		requests response.
*/
- (NSHTTPURLResponse *)response;


/*!
    @method     
    @abstract   Delegate when request receives response.
*/
- (void)connection:(NSURLConnection *)connection
	didReceiveResponse:(NSHTTPURLResponse *)response;

/*!
    @method     
    @abstract   Delegate when request recevies redirect.
*/
- (NSURLRequest *)connection:(NSURLConnection *)connection
	willSendRequest:(NSURLRequest *)request
	redirectResponse:(NSHTTPURLResponse *)redirectResponse;	

/*!
    @method     
    @abstract   Delegate when connection receives data.
*/
- (void)connection:(NSURLConnection *)connection
	didReceiveData:(NSData *)data;

/*!
    @method     
    @abstract   Delegate when connection recevies an error.
*/
- (void)connection:(NSURLConnection *)connection
	didFailWithError:(NSError *)error;

/*!
    @method     
    @abstract   Delegate when connection finishes loading.
*/
- (void)connectionDidFinishLoading:(NSURLConnection *)connection;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (void)dealloc;

@end
